Skip to content

docs: SharePoint connector docs missing new auth flows, write support, and sharepoint:// URL scheme#1681

Merged
lukekim merged 1 commit into
trunkfrom
fix/1660-sharepoint-auth-and-write
May 7, 2026
Merged

docs: SharePoint connector docs missing new auth flows, write support, and sharepoint:// URL scheme#1681
lukekim merged 1 commit into
trunkfrom
fix/1660-sharepoint-auth-and-write

Conversation

@claudespice
Copy link
Copy Markdown
Collaborator

Summary

Fixes #1660

Updates the SharePoint connector documentation to reflect the object-store listing connector revamp shipped in spiceai/spiceai#10473 — documenting the four new auth flows, the new sharepoint:// URL scheme, and the new write-side parameters.

Changes

  • website/docs/components/data-connectors/sharepoint.md
    • Auth flows: Added authorization code, refresh token, device code, and SAML 2.0 bearer (RFC 7522) flows — six total — alongside the existing client_secret and bearer_token flows. Documented sharepoint_redirect_uri (required with auth_code) and sharepoint_scope (defaults to https://graph.microsoft.com/.default).
    • Write support: Documented sharepoint_conflict_behavior (replace (default) / fail / rename) and sharepoint_max_put_bytes (default 1073741824, i.e. 1 GiB), with a limitation note that only replace is compatible with INSERT INTO / COPY TO.
    • sharepoint:// URL scheme: New section documenting the five drive forms (me / drives / sites / users / groups), routing through DataFusion's ListingTable, and pointing readers to the standard listing-table parameters.
    • Required Microsoft Graph permissions: Split into read-only baseline (Sites.Read.All, Files.Read.All, User.Read, GroupMember.Read.All) and the additional Files.ReadWrite / Sites.ReadWrite.All needed for write workflows.
    • Parameter accuracy: Reclassified sharepoint_client_id and sharepoint_tenant_id from "Required" to "Conditional" — they're not required for the bearer_token flow. Updated the auth-exclusivity note to list all six flows.
    • Examples: Added end-to-end examples for SELECT from a SharePoint site library, INSERT INTO, COPY TO Parquet, CREATE EXTERNAL TABLE, and binary blob round-trip via COPY TO (FORMAT binary).

Reference

Verified against spiceai/spiceai at origin/trunk:

  • crates/data-connectors/connector-sharepoint/src/lib.rsPARAMETERS registers all eight new auth/write parameters; build_auth_from_params enforces "exactly one auth flow"; parse_conflict_behavior and parse_max_put_bytes provide the write defaults.
  • crates/data_components/src/sharepoint/auth/mod.rsDEFAULT_SCOPE = "https://graph.microsoft.com/.default"; the SharepointAuth enum dispatches the six flows.
  • crates/data_components/src/sharepoint/url.rsSharepointUrl::from_url parses the five drive kinds.
  • crates/data_components/src/sharepoint/object_store.rsDEFAULT_MAX_PUT_BYTES = 1024 * 1024 * 1024 (1 GiB); only Replace is honored by put / put_multipart.
  • crates/data-connectors/connector-sharepoint/README.md — confirms the Microsoft Graph scopes for read-only vs write workflows.

Test plan

  • cd website && npm run build passes locally
  • No broken-link-checker failures
  • Addition is in the unversioned website/docs/ only (per skill rule for new content)
  • Existing examples preserved; no behavior changes implied beyond what shipped on trunk

…, and sharepoint:// URL scheme

Fixes #1660

Updates the SharePoint connector documentation to reflect the
object-store listing connector update:

- Documents the four new auth flows beyond client_secret /
  bearer_token: authorization code, refresh token, device code, and
  SAML 2.0 bearer (RFC 7522), plus the supporting redirect_uri and
  scope parameters.
- Adds write-side parameters sharepoint_conflict_behavior (default
  replace) and sharepoint_max_put_bytes (default 1 GiB), with
  limitations noting only replace is compatible with INSERT/COPY TO.
- Documents the new sharepoint:// (double-slash) object-store URL
  scheme and the five drive forms (me / drives / sites / users /
  groups), and links the listing-table parameters reference.
- Clarifies that sharepoint_client_id and sharepoint_tenant_id are
  Conditional (not required for bearer_token alone), and lists all
  six flows in the auth-exclusivity note.
- Notes that write workflows additionally require Files.ReadWrite and
  Sites.ReadWrite.All Microsoft Graph scopes.

Verified against spiceai/spiceai trunk
(crates/data-connectors/connector-sharepoint/src/lib.rs and
crates/data_components/src/sharepoint/{auth,object_store,url}.rs).
@claudespice claudespice added enhancement New feature or request area/docs labels May 7, 2026
@claudespice claudespice self-assigned this May 7, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

🚀 deployed to https://d328ca4f.spiceai-org-website.pages.dev

@lukekim lukekim merged commit d3ca431 into trunk May 7, 2026
6 of 11 checks passed
@lukekim lukekim deleted the fix/1660-sharepoint-auth-and-write branch May 7, 2026 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: SharePoint connector docs missing new auth flows, write support, and sharepoint:// URL scheme

2 participants